/*
 *  PPKeychain.h
 *  PigeonsFoundation
 *
 *  Created by Jacob Basham on 1/24/07.
 *  Copyright 2007, PaperPigeons.net
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *  1. Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *	2. Redistributions in binary form must reproduce the above copyright 
 *	   notice, this list of conditions and the following disclaimer in 
 *	   the documentation and/or other materials provided with the distribution.
 *	3. Neither the name of PaperPigeons.net nor the names of its contributors 
 *	   may be used to endorse or promote products derived from this software 
 *	   without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 *	FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 *	COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 *	BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 *	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 *	LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
 *	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *	POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>
#import <Security/Security.h>


/*!
    @class
    @abstract    ObjectiveC Keychain wrapper.
    @discussion  Perhaps this should be changed to a "sharedKeychain" type api.
*/

@interface PPKeychain : NSObject 
{
}

/*!
    @method     
    @abstract   Returns users version of keychain.
    @result 	Keychains version.
*/
+ (int)version;


/*!
    @method     
    @abstract   Find a password for an application.
	@param source Application name.
	@param account Account name (username).
    @result Password, or nil.
*/
+ (NSString *)genericPasswordForSource:(NSString *)source
	account:(NSString *)account;


/*!
    @method     
    @abstract   Find a password for a website.
	@param server
	@param domain
	@param account
	@param path
	@param port
	@param protocol
	@param authType
	@result Password, or nil.
*/	
+ (NSString *)internetPasswordForServer:(NSString *)server 
	domain:(NSString *)domain
	account:(NSString *)account
	path:(NSString *)path
	port:(int)port
	protocol:(SecProtocolType)protocol
	authenticationType:(SecAuthenticationType)authType;


/*!
    @method     
    @abstract   Set password for an application.
	@param source Application name
	@param account Account name (username).
	@param password Password to save.
*/
+ (void)setGenericPasswordForSource:(NSString *)source
	account:(NSString *)account
	password:(NSString *)password;


/*!
    @method     
    @abstract   Set password for a website
	@param server
	@param domain
	@param account
	@param password
	@param path
	@param port
	@param protocol
	@param authType
*/
+ (void)setInternetPasswordForServer:(NSString *)server
	domain:(NSString *)domain
	account:(NSString *)account
	password:(NSString *)password
	path:(NSString *)path
	port:(int)port
	protocol:(SecProtocolType)protocol
	authenticationType:(SecAuthenticationType)authType;

@end
